<h1>easy-yapi</h1>
<br/>
<a href="https://github.com/tangcent/easy-yapi">GitHub</a> |
<a href="https://github.com/tangcent/easy-yapi/issues">Issues</a> |
<a href="https://easyyapi.com">Guide</a>
<br/>
<br/>

<b>优雅的文档来自优雅的注释</b>
<br/>
<br/>

<b>详细信息参考:<a href="https://easyyapi.com">Guide</a></b>
<ul>导出API到Yapi,有四种方法:
    <li>
        1. 打开spring项目中的Controller文件或者在IDEA的左边项目文件区域选择文件或者文件夹
        使用快捷键"alt shift E(windows)/ctrl E(mac)"
        然后选择要导出的API,选择导出渠道为yapi
        点击[✔]按钮或者按回车键完成导出
    </li>
    <li>
        2. 打开spring项目中的Controller文件
        右键文件内容选择generate...或者用"[Alt + Insert]/[Ctrl+Enter](快捷键可能不一样)"
        然后选择"ExportYapi"
    </li>
    <li>
        3. 在IDEA的左边项目文件区域选择文件或者文件夹
        鼠标点击最上方[Code -> ExportYapi]
    </li>
    <li>
        4. 鼠标点击最上方[Code -> YapiDashBoard]
        然后就可以用鼠标将左边的API拖动到右边yapi目录中
    </li>
</ul>

<b>Features</b>
<ul>
    <li>Export Api(beta)
        <br>
        1. Open existed Spring Controller File Or Select files or directories from project navigation
        You can use by this : "alt shift E(windows)/ctrl E(mac)"
        <br>
        2.select apis and channel
        <br>
        3.click [✔] button or press enter key
    </li>
    <li>Export Api To Postman
        <br>
        There are two ways to export api.
        <br>
        1. Open existed Spring Controller File
        You can use by this : "Right click in the file -> generate... " or use its shortcuts "[Alt +
        Insert]/[Ctrl+Enter]" , then
        choose the action "ExportPostman"
        <br>
        2. Select files or directories from project navigation
        You can use by this : "Click [Code -> ExportPostman] in top"
    </li>
    <li>Quick API requests from code
        <br>
        Open existed Spring Controller File
        Right click in the file -> generate... or use its shortcuts "[Alt + Insert]/[Ctrl+Enter]"
        then choose the action "Call"
    </li>
    <li>Export API To Markdown(beta)
        <br>
        There are two ways to export api.
        <br>
        1. Open existed Spring Controller File
        You can use by this : "Right click in the file -> generate... " or use its shortcuts "[Alt +
        Insert]/[Ctrl+Enter]" , then
        choose the action "ExportMarkdown"
        <br>
        2. Select files or directories from project navigation
        You can use by this : "Click [Code -> ExportMarkdown] in top"
    </li>
    <li>ApiDashBoard
        <br>
        You can use by this : "Click [Code -> ApiDashBoard] in top"
        Then you can easily export api by drag it from project(left) to postman(right)
    </li>
    <li>YApiDashBoard
        <br>
        You can use by this : "Click [Code -> YApiDashBoard] in top"
        Then you can easily export api by drag it from project(left) to yapi(right)
    </li>
    <li>Debug
        <br>
        You can use by this : "Click [Code -> Debug] in top"
        Then you can easily debug script
    </li>
</ul>
<br/>